MapLibre Native for Android/com.mapbox.mapboxsdk.style.layers/Property

Property

Paint/Layout properties for Layer

Types

@Retention(value = RetentionPolicy.SOURCE)

annotation class ANCHOR

Whether extruded geometries are lit relative to the map or viewport.

CIRCLE_PITCH_ALIGNMENT

@Retention(value = RetentionPolicy.SOURCE)

annotation class CIRCLE_PITCH_ALIGNMENT

Orientation of circle when map is pitched.

CIRCLE_PITCH_SCALE

@Retention(value = RetentionPolicy.SOURCE)

annotation class CIRCLE_PITCH_SCALE

Controls the scaling behavior of the circle when the map is pitched.

CIRCLE_TRANSLATE_ANCHOR

@Retention(value = RetentionPolicy.SOURCE)

annotation class CIRCLE_TRANSLATE_ANCHOR

Controls the frame of reference for `circle-translate`.

FILL_EXTRUSION_TRANSLATE_ANCHOR

@Retention(value = RetentionPolicy.SOURCE)

annotation class FILL_EXTRUSION_TRANSLATE_ANCHOR

Controls the frame of reference for `fill-extrusion-translate`.

FILL_TRANSLATE_ANCHOR

@Retention(value = RetentionPolicy.SOURCE)

annotation class FILL_TRANSLATE_ANCHOR

Controls the frame of reference for `fill-translate`.

HILLSHADE_ILLUMINATION_ANCHOR

@Retention(value = RetentionPolicy.SOURCE)

annotation class HILLSHADE_ILLUMINATION_ANCHOR

Direction of light source when map is rotated.

@Retention(value = RetentionPolicy.SOURCE)

annotation class ICON_ANCHOR

Part of the icon placed closest to the anchor.

ICON_PITCH_ALIGNMENT

@Retention(value = RetentionPolicy.SOURCE)

annotation class ICON_PITCH_ALIGNMENT

Orientation of icon when map is pitched.

ICON_ROTATION_ALIGNMENT

@Retention(value = RetentionPolicy.SOURCE)

annotation class ICON_ROTATION_ALIGNMENT

In combination with `symbol-placement`, determines the rotation behavior of icons.

@Retention(value = RetentionPolicy.SOURCE)

annotation class ICON_TEXT_FIT

Scales the icon to fit around the associated text.

ICON_TRANSLATE_ANCHOR

@Retention(value = RetentionPolicy.SOURCE)

annotation class ICON_TRANSLATE_ANCHOR

Controls the frame of reference for `icon-translate`.

@Retention(value = RetentionPolicy.SOURCE)

annotation class LINE_CAP

The display of line endings.

@Retention(value = RetentionPolicy.SOURCE)

annotation class LINE_JOIN

The display of lines when joining.

LINE_TRANSLATE_ANCHOR

@Retention(value = RetentionPolicy.SOURCE)

annotation class LINE_TRANSLATE_ANCHOR

Controls the frame of reference for `line-translate`.

RASTER_RESAMPLING

@Retention(value = RetentionPolicy.SOURCE)

annotation class RASTER_RESAMPLING

The resampling/interpolation method to use for overscaling, also known as texture magnification filter

SYMBOL_PLACEMENT

@Retention(value = RetentionPolicy.SOURCE)

annotation class SYMBOL_PLACEMENT

Label placement relative to its geometry.

@Retention(value = RetentionPolicy.SOURCE)

annotation class SYMBOL_Z_ORDER

Controls the order in which overlapping symbols in the same layer are rendered

@Retention(value = RetentionPolicy.SOURCE)

annotation class TEXT_ANCHOR

Part of the text placed closest to the anchor.

@Retention(value = RetentionPolicy.SOURCE)

annotation class TEXT_JUSTIFY

Text justification options.

TEXT_PITCH_ALIGNMENT

@Retention(value = RetentionPolicy.SOURCE)

annotation class TEXT_PITCH_ALIGNMENT

Orientation of text when map is pitched.

TEXT_ROTATION_ALIGNMENT

@Retention(value = RetentionPolicy.SOURCE)

annotation class TEXT_ROTATION_ALIGNMENT

In combination with `symbol-placement`, determines the rotation behavior of the individual glyphs forming the text.

@Retention(value = RetentionPolicy.SOURCE)

annotation class TEXT_TRANSFORM

Specifies how to capitalize text, similar to the CSS `text-transform` property.

TEXT_TRANSLATE_ANCHOR

@Retention(value = RetentionPolicy.SOURCE)

annotation class TEXT_TRANSLATE_ANCHOR

Controls the frame of reference for `text-translate`.

TEXT_WRITING_MODE

@Retention(value = RetentionPolicy.SOURCE)

annotation class TEXT_WRITING_MODE

The property allows control over a symbol's orientation.

@Retention(value = RetentionPolicy.SOURCE)

annotation class VISIBILITY

Properties

val ANCHOR_MAP: String = "map"

The position of the light source is aligned to the rotation of the map.

ANCHOR_VIEWPORT

val ANCHOR_VIEWPORT: String = "viewport"

The position of the light source is aligned to the rotation of the viewport.

CIRCLE_PITCH_ALIGNMENT_MAP

val CIRCLE_PITCH_ALIGNMENT_MAP: String = "map"

The circle is aligned to the plane of the map.

CIRCLE_PITCH_ALIGNMENT_VIEWPORT

val CIRCLE_PITCH_ALIGNMENT_VIEWPORT: String = "viewport"

The circle is aligned to the plane of the viewport.

CIRCLE_PITCH_SCALE_MAP

val CIRCLE_PITCH_SCALE_MAP: String = "map"

Circles are scaled according to their apparent distance to the camera.

CIRCLE_PITCH_SCALE_VIEWPORT

val CIRCLE_PITCH_SCALE_VIEWPORT: String = "viewport"

Circles are not scaled.

CIRCLE_TRANSLATE_ANCHOR_MAP

val CIRCLE_TRANSLATE_ANCHOR_MAP: String = "map"

The circle is translated relative to the map.

CIRCLE_TRANSLATE_ANCHOR_VIEWPORT

val CIRCLE_TRANSLATE_ANCHOR_VIEWPORT: String = "viewport"

The circle is translated relative to the viewport.

FILL_EXTRUSION_TRANSLATE_ANCHOR_MAP

val FILL_EXTRUSION_TRANSLATE_ANCHOR_MAP: String = "map"

The fill extrusion is translated relative to the map.

FILL_EXTRUSION_TRANSLATE_ANCHOR_VIEWPORT

val FILL_EXTRUSION_TRANSLATE_ANCHOR_VIEWPORT: String = "viewport"

The fill extrusion is translated relative to the viewport.

FILL_TRANSLATE_ANCHOR_MAP

val FILL_TRANSLATE_ANCHOR_MAP: String = "map"

The fill is translated relative to the map.

FILL_TRANSLATE_ANCHOR_VIEWPORT

val FILL_TRANSLATE_ANCHOR_VIEWPORT: String = "viewport"

The fill is translated relative to the viewport.

HILLSHADE_ILLUMINATION_ANCHOR_MAP

val HILLSHADE_ILLUMINATION_ANCHOR_MAP: String = "map"

The hillshade illumination is relative to the north direction.

HILLSHADE_ILLUMINATION_ANCHOR_VIEWPORT

val HILLSHADE_ILLUMINATION_ANCHOR_VIEWPORT: String = "viewport"

The hillshade illumination is relative to the top of the viewport.

ICON_ANCHOR_BOTTOM

val ICON_ANCHOR_BOTTOM: String = "bottom"

The bottom of the icon is placed closest to the anchor.

ICON_ANCHOR_BOTTOM_LEFT

val ICON_ANCHOR_BOTTOM_LEFT: String = "bottom-left"

The bottom left corner of the icon is placed closest to the anchor.

ICON_ANCHOR_BOTTOM_RIGHT

val ICON_ANCHOR_BOTTOM_RIGHT: String = "bottom-right"

The bottom right corner of the icon is placed closest to the anchor.

ICON_ANCHOR_CENTER

val ICON_ANCHOR_CENTER: String = "center"

The center of the icon is placed closest to the anchor.

ICON_ANCHOR_LEFT

val ICON_ANCHOR_LEFT: String = "left"

The left side of the icon is placed closest to the anchor.

ICON_ANCHOR_RIGHT

val ICON_ANCHOR_RIGHT: String = "right"

The right side of the icon is placed closest to the anchor.

ICON_ANCHOR_TOP

val ICON_ANCHOR_TOP: String = "top"

The top of the icon is placed closest to the anchor.

ICON_ANCHOR_TOP_LEFT

val ICON_ANCHOR_TOP_LEFT: String = "top-left"

The top left corner of the icon is placed closest to the anchor.

ICON_ANCHOR_TOP_RIGHT

val ICON_ANCHOR_TOP_RIGHT: String = "top-right"

The top right corner of the icon is placed closest to the anchor.

ICON_PITCH_ALIGNMENT_AUTO

val ICON_PITCH_ALIGNMENT_AUTO: String = "auto"

Automatically matches the value of ICON_ROTATION_ALIGNMENT.

ICON_PITCH_ALIGNMENT_MAP

val ICON_PITCH_ALIGNMENT_MAP: String = "map"

The icon is aligned to the plane of the map.

ICON_PITCH_ALIGNMENT_VIEWPORT

val ICON_PITCH_ALIGNMENT_VIEWPORT: String = "viewport"

The icon is aligned to the plane of the viewport.

ICON_ROTATION_ALIGNMENT_AUTO

val ICON_ROTATION_ALIGNMENT_AUTO: String = "auto"

When SYMBOL_PLACEMENT is set to SYMBOL_PLACEMENT_POINT, this is equivalent to ICON_ROTATION_ALIGNMENT_VIEWPORT.

ICON_ROTATION_ALIGNMENT_MAP

val ICON_ROTATION_ALIGNMENT_MAP: String = "map"

When SYMBOL_PLACEMENT is set to SYMBOL_PLACEMENT_POINT, aligns icons east-west.

ICON_ROTATION_ALIGNMENT_VIEWPORT

val ICON_ROTATION_ALIGNMENT_VIEWPORT: String = "viewport"

Produces icons whose x-axes are aligned with the x-axis of the viewport, regardless of the value of SYMBOL_PLACEMENT.

ICON_TEXT_FIT_BOTH

val ICON_TEXT_FIT_BOTH: String = "both"

The icon is scaled in both x- and y-dimensions.

ICON_TEXT_FIT_HEIGHT

val ICON_TEXT_FIT_HEIGHT: String = "height"

The icon is scaled in the y-dimension to fit the height of the text.

ICON_TEXT_FIT_NONE

val ICON_TEXT_FIT_NONE: String = "none"

The icon is displayed at its intrinsic aspect ratio.

ICON_TEXT_FIT_WIDTH

val ICON_TEXT_FIT_WIDTH: String = "width"

The icon is scaled in the x-dimension to fit the width of the text.

ICON_TRANSLATE_ANCHOR_MAP

val ICON_TRANSLATE_ANCHOR_MAP: String = "map"

Icons are translated relative to the map.

ICON_TRANSLATE_ANCHOR_VIEWPORT

val ICON_TRANSLATE_ANCHOR_VIEWPORT: String = "viewport"

Icons are translated relative to the viewport.

val LINE_CAP_BUTT: String = "butt"

A cap with a squared-off end which is drawn to the exact endpoint of the line.

val LINE_CAP_ROUND: String = "round"

A cap with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line's width and centered on the endpoint of the line.

LINE_CAP_SQUARE

val LINE_CAP_SQUARE: String = "square"

A cap with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line's width.

LINE_JOIN_BEVEL

val LINE_JOIN_BEVEL: String = "bevel"

A join with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line's width.

LINE_JOIN_MITER

val LINE_JOIN_MITER: String = "miter"

A join with a sharp, angled corner which is drawn with the outer sides beyond the endpoint of the path until they meet.

LINE_JOIN_ROUND

val LINE_JOIN_ROUND: String = "round"

A join with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line's width and centered on the endpoint of the line.

LINE_TRANSLATE_ANCHOR_MAP

val LINE_TRANSLATE_ANCHOR_MAP: String = "map"

The line is translated relative to the map.

LINE_TRANSLATE_ANCHOR_VIEWPORT

val LINE_TRANSLATE_ANCHOR_VIEWPORT: String = "viewport"

The line is translated relative to the viewport.

val NONE: String = "none"

The layer is hidden.

RASTER_RESAMPLING_LINEAR

val RASTER_RESAMPLING_LINEAR: String = "linear"

(Bi)linear filtering interpolates pixel values using the weighted average of the four closest original source pixels creating a smooth but blurry look when overscaled

RASTER_RESAMPLING_NEAREST

val RASTER_RESAMPLING_NEAREST: String = "nearest"

Nearest neighbor filtering interpolates pixel values using the nearest original source pixel creating a sharp but pixelated look when overscaled

SYMBOL_PLACEMENT_LINE

val SYMBOL_PLACEMENT_LINE: String = "line"

The label is placed along the line of the geometry.

SYMBOL_PLACEMENT_LINE_CENTER

val SYMBOL_PLACEMENT_LINE_CENTER: String = "line-center"

The label is placed at the center of the line of the geometry.

SYMBOL_PLACEMENT_POINT

val SYMBOL_PLACEMENT_POINT: String = "point"

The label is placed at the point where the geometry is located.

SYMBOL_Z_ORDER_AUTO

val SYMBOL_Z_ORDER_AUTO: String = "auto"

If symbol sort key is set, sort based on that.

SYMBOL_Z_ORDER_SOURCE

val SYMBOL_Z_ORDER_SOURCE: String = "source"

Symbols will be rendered in the same order as the source data with no sorting applied.

SYMBOL_Z_ORDER_VIEWPORT_Y

val SYMBOL_Z_ORDER_VIEWPORT_Y: String = "viewport-y"

Symbols will be sorted by their y-position relative to the viewport.

TEXT_ANCHOR_BOTTOM

val TEXT_ANCHOR_BOTTOM: String = "bottom"

The bottom of the text is placed closest to the anchor.

TEXT_ANCHOR_BOTTOM_LEFT

val TEXT_ANCHOR_BOTTOM_LEFT: String = "bottom-left"

The bottom left corner of the text is placed closest to the anchor.

TEXT_ANCHOR_BOTTOM_RIGHT

val TEXT_ANCHOR_BOTTOM_RIGHT: String = "bottom-right"

The bottom right corner of the text is placed closest to the anchor.

TEXT_ANCHOR_CENTER

val TEXT_ANCHOR_CENTER: String = "center"

The center of the text is placed closest to the anchor.

TEXT_ANCHOR_LEFT

val TEXT_ANCHOR_LEFT: String = "left"

The left side of the text is placed closest to the anchor.

TEXT_ANCHOR_RIGHT

val TEXT_ANCHOR_RIGHT: String = "right"

The right side of the text is placed closest to the anchor.

TEXT_ANCHOR_TOP

val TEXT_ANCHOR_TOP: String = "top"

The top of the text is placed closest to the anchor.

TEXT_ANCHOR_TOP_LEFT

val TEXT_ANCHOR_TOP_LEFT: String = "top-left"

The top left corner of the text is placed closest to the anchor.

TEXT_ANCHOR_TOP_RIGHT

val TEXT_ANCHOR_TOP_RIGHT: String = "top-right"

The top right corner of the text is placed closest to the anchor.

TEXT_JUSTIFY_AUTO

val TEXT_JUSTIFY_AUTO: String = "auto"

The text is aligned towards the anchor position.

TEXT_JUSTIFY_CENTER

val TEXT_JUSTIFY_CENTER: String = "center"

The text is centered.

TEXT_JUSTIFY_LEFT

val TEXT_JUSTIFY_LEFT: String = "left"

The text is aligned to the left.

TEXT_JUSTIFY_RIGHT

val TEXT_JUSTIFY_RIGHT: String = "right"

The text is aligned to the right.

TEXT_PITCH_ALIGNMENT_AUTO

val TEXT_PITCH_ALIGNMENT_AUTO: String = "auto"

Automatically matches the value of TEXT_ROTATION_ALIGNMENT.

TEXT_PITCH_ALIGNMENT_MAP

val TEXT_PITCH_ALIGNMENT_MAP: String = "map"

The text is aligned to the plane of the map.

TEXT_PITCH_ALIGNMENT_VIEWPORT

val TEXT_PITCH_ALIGNMENT_VIEWPORT: String = "viewport"

The text is aligned to the plane of the viewport.

TEXT_ROTATION_ALIGNMENT_AUTO

val TEXT_ROTATION_ALIGNMENT_AUTO: String = "auto"

When SYMBOL_PLACEMENT is set to SYMBOL_PLACEMENT_POINT, this is equivalent to TEXT_ROTATION_ALIGNMENT_VIEWPORT.

TEXT_ROTATION_ALIGNMENT_MAP

val TEXT_ROTATION_ALIGNMENT_MAP: String = "map"

When SYMBOL_PLACEMENT is set to SYMBOL_PLACEMENT_POINT, aligns text east-west.

TEXT_ROTATION_ALIGNMENT_VIEWPORT

val TEXT_ROTATION_ALIGNMENT_VIEWPORT: String = "viewport"

Produces glyphs whose x-axes are aligned with the x-axis of the viewport, regardless of the value of SYMBOL_PLACEMENT.

TEXT_TRANSFORM_LOWERCASE

val TEXT_TRANSFORM_LOWERCASE: String = "lowercase"

Forces all letters to be displayed in lowercase.

TEXT_TRANSFORM_NONE

val TEXT_TRANSFORM_NONE: String = "none"

The text is not altered.

TEXT_TRANSFORM_UPPERCASE

val TEXT_TRANSFORM_UPPERCASE: String = "uppercase"

Forces all letters to be displayed in uppercase.

TEXT_TRANSLATE_ANCHOR_MAP

val TEXT_TRANSLATE_ANCHOR_MAP: String = "map"

The text is translated relative to the map.

TEXT_TRANSLATE_ANCHOR_VIEWPORT

val TEXT_TRANSLATE_ANCHOR_VIEWPORT: String = "viewport"

The text is translated relative to the viewport.

TEXT_WRITING_MODE_HORIZONTAL

val TEXT_WRITING_MODE_HORIZONTAL: String = "horizontal"

If a text's language supports horizontal writing mode, symbols with point placement would be laid out horizontally.

TEXT_WRITING_MODE_VERTICAL

val TEXT_WRITING_MODE_VERTICAL: String = "vertical"

If a text's language supports vertical writing mode, symbols with point placement would be laid out vertically.

val VISIBLE: String = "visible"

The layer is shown.